jQuery插件开发详解(带demo)

jQuery的链式调用是非常好用,
比如$(".class").addClass(".abc").siblings().removeClass(".abc");
这个写法在导航中点击某个tab修改样式十分常见,链式调用也是jQuery很重要的特点,话扯得有点远。

jQuery这么热门还有一个重要的原因——可扩展性,它允许我们通过方法来扩展jQuery。

我们该如何扩展jQuery呢?主要可以通过下面2个来扩展:

  • jQuery.extend
  • jQuery.fn

当然上面的也等价于:

  • $.extend
  • $.fn
为什么呢?看过jQuery源码的人都知道,在jQuery中这么一种写法:
window.$ = window.jQuery = jQuery;
这里就不详细描述了,想深究的人可以查阅其他的资料
下面开始介绍如何通过上面的两种方法实现我们想要的功能:
  • $.extend
    如果把jQuery当成一个类,$.extend相当于为该类添加了静态方法extend。
我们可以通过$符号调用($.functionName())而不需要选中DOM元素($('.className').functionName())。

假设现在有个需求,我们需要扩展一个写日志的函数——日期+错误信息,我们可以这么写:

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>demo</title>
</head>
<body>
    <script src="jquery.js"></script>
    <script>
        $.extend({
            log: function(message) {
                var now = new Date(),
                    y = now.getFullYear(),
                    m = now.getMonth() + 1,
                    d = now.getDate(),
                    h = now.getHours(),
                    min = now.getMinutes(),
                    s = now.getSeconds(),
                    time = y + '/' + m + '/' + d + ' ' + h + ':' + min + ':' + s;
                    console.log(time + ' My App: ' + message);
            }
        });
        $.log("出错啦!");
    </script>
</body>
</html>

Chrome浏览器f12,发现输出了:

2016/1/28 15:35:16 My App: 出错啦!

是不是很简单,再来看看 $.fn.extend。

  • $.fn、
    $.fn等于$.prototype
    基本的书写格式如下:
$.fn.pluginName = function(options) {
  //这里写我们想要的效果
}
调用时和上面的不一样,需要操作具体的对象:
$(".ele").pluginName(options);

同样,假设我们想修改某个元素的颜色(颜色不固定),我们可以这么写:

$.fn.changeColor = function(colorName){
      this.css("color":colorName? colorName : '#000'); 
}
通过上面的写法,提高了代码的复用性,可扩展性也高:
$("span").changeColor();--span标签颜色变为默认的:#000
$("span").changeColor("#f06");--span标签颜色变为默认的:#f06
$("p").changeColor("#f06");--p标签颜色变为默认的:#f06
备注:this指代的是我们在调用该插件时,jQuery选择器选中的元素。this和prototype 都是js中十分重要的概念,希望大家都能多了解这么面的知识。

如果我们有这么一个需求,一次性修改多个样式,且每个样式存在一个对应的默认值。

  • 首先先看这一段代码
<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>demo</title>
</head>
<body>
    <p class="text1">测试文字</p>
    <p class="text2">测试文字</p>
    <script src="jquery.js"></script>
    <script>
        $.fn.changeColor = function(options){
            this.defaults = {
                'color': '#000',
                'fontSize': '14px',
                'fontWeight': 'normal'
            };
            this.opt = $.extend(this.defaults, options);
            console.log(this.defaults);
            this.css({
                'color': this.opt.color,
                'font-size': this.opt.fontSize,
                'font-weight': this.opt.fontWeight
            });
        }
        $(".text1").changeColor();
        $(".text2").changeColor({'color': '#f06','fontSize': '18px','fontWeight': 'bold'});
    </script>
</body>
</html>

执行结果:

pic1.png

界面上的样式结果是我们所要的,但是我们奇怪的发现第二次打印 console.log(this.defaults);时,defaults的值被我们所传的options覆盖了。
造成这个结果的原因是:

this.opt = $.extend(this.defaults, options);
使用jQuery的extend方法,
extend方法传递单个对象的情况下,这个对象会合并到jQuery身上,
而当用extend方法传递一个以上的参数时,它会将所有参数对象合并到第一个里,
同时,如果对象中有同名属性时,合并的时候后面的会覆盖前面的。
解决办法就是使用下面的这句话替代上面的:
this.opt = $.extend({}, this.defaults, options);

你看执行结果正常了,上面写的其实没有必要用extend就可以实现一次性修改多个样式,且每个样式存在一个对应的默认值。之所以例子中用到这个,就是想说明extend的这个注意点。

pic2.png

但是这样写仍然可能会出现问题,更好的写法是:

;(function($,window,document,undefined){
           $.fn.changeColor = function(options){
                this.defaults = {
                    'color': '#000',
                    'fontSize': '14px',
                    'fontWeight': 'normal'
                };
                this.opt = $.extend({}, this.defaults, options);
                console.log(this.defaults);
                this.css({
                    'color': this.opt.color,
                    'font-size': this.opt.fontSize,
                    'font-weight': this.opt.fontWeight
                });
            }
})(jQuery,window,document);

将我们要实现的代码封装在

;(function($,window,document,undefined){
    //想要实现的功能的代码
})(jQuery,window,document);
这里的";"最好添加上,可以避免代码压缩时出现问题



这种将系统变量以变量形式传递到插件内部*的方法可以避免别人写的代码将window, undefined等这些系统变量或者关键字修改掉了,而我们又在自己的代码里面进行了使用。
看过一篇文章,里面有对这个undefined使用的介绍我这就直接复制过来了。

为了得到没有被修改的undefined,
我们并没有传递这个参数,但却在接收时接收了它,因为实际并没有传,
所以‘undefined’那个位置接收到的就是真实的'undefined'了。

其中精髓,大家细细体会~

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 162,710评论 4 376
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 68,839评论 2 308
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 112,295评论 0 255
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 44,776评论 0 223
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 53,198评论 3 297
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 41,074评论 1 226
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 32,200评论 2 322
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,986评论 0 214
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,733评论 1 250
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,877评论 2 254
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 32,348评论 1 265
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,675评论 3 265
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 33,393评论 3 246
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,209评论 0 9
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,996评论 0 201
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 36,212评论 2 287
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 36,003评论 2 280

推荐阅读更多精彩内容